v6.0.0

Compare Source

The yeoman-generator package now export a native ESM module. (Learn more about ESM)

Notable changes:

• Convert to typescript
• Drop node 12/14 support.
• Requires yeoman-environment ^3.18.4.
• Provides built-in types.
• Uses new @yeoman/types for environment/generator interoperability. May conflict with @types/yeoman-* types.
• Move skipParseOptions and customPriorities to features c12806a
• Drop deprecated install (and not included by default) action 1a856b1
  Install action was not scalable. A separated task package can be considered at yeoman-api.
• run-async is not provided anymore:
  Convert to Promises or use run-async v3:

import runAsync from 'run-async';
class Gen {
  asyncTaskWithCallback: runAsync(function() {
    const done = this.async();
    asyncMethod(done);
  }),
}

• composeWith is async:
  • If used inside constructor, move it to _postConstruct or beforeQueue.
  • Due to complexity, prefer composeWith(generator, composeOptions signature.

v5.10.0

Compare Source

• accept yeoman-environment v4 a8c526b

v5.9.0

Compare Source

• adjusts for yeoman-api 553537b

v5.8.0

Compare Source

• always create a new mem-fs-editor instance instead of using shared instance. 7bec553

v5.7.1

Compare Source

• add options to queueTransformStream. dac0db6

v5.7.0

Compare Source

• make prompt default value dynamic ea460eb
• show error message when task fails. 92cc534

v5.6.1

Compare Source

• Move custom args inside the runAsync for better error handling ef3f702
• Allow task to override taskPrefix. d2f4274
• Fix destinationRoot overridden by current value. f6e1e67
• Fix resolved when not passed by options. 52ac34c

v5.6.0

Compare Source

• Bump version of shelljs to avoid vulnerable 0.8.4 version (#​1325) 9c798e6
• Return earlier at extractTasksFromPriority (#​1324) 0bfb51a
• Allow to edit priorities. (#​1323) 2a6cf47

v5.5.2

Compare Source

• Fix createStorage with options. 185a408

v5.5.1

Compare Source

• Add options parameter to createStorage. 82db7d0

v5.5.0

Compare Source

• Rework private methods. dac452e
• Add args to queueTask. cf8580f
• Add optional support to sorted Storage. cf2e53f
• Documentation improvements.

v5.4.2

Compare Source

• Fix composing with esm generator (#​1308) 4b7f115

v5.4.1

Compare Source

• Fix for esm generator. 979b63d

v5.4.0

Compare Source

• Add immediately parameter to composeWith 8fd5c86
• Add support to beforeQueue. b8747da

v5.3.0

Compare Source

• Implement async fs methods. (#​1301) 9cab8c9
• Add test for path unsafe string. (#​1300) 8bc6267
• Answer stored inside config should take precedence over suggestions. (#​1297) c1c847d
• Bump mem-fs-editor to 9.0.0 (#​1298) ce12e7f
• Implement taskPrefix feature. (#​1296) 84551ee
• Bump yeoman-test to 6.0.0 (#​1295) 5f3b2fb
• Bump mem-fs to 2.0.0 and mem-fs-editor to 8.1.2 (#​1290) d8dfd10
• Load environment resources when running help. (#​1288) 3579322
• Fix 4.x api documentation link. a0313cd
• Add api documentation link for 4.x b44ec7d

v5.2.0

Compare Source

• Changes to required/recommended yeoman-environment version. de61c24, 4587a29, d101a41, 0898158
• Add optional peer dependency on yeoman-environment 26797e6
• Add support to tasksMatchingPriority feature. 93e01ea
• Move uniqueBy calculation to the constructor. 4dcda8a
• Resolve dependencies with empty versions to latest. d952868

v5.1.0

Compare Source

• Add features argument to constructor. 9729a58
• Delete option instead of setting undefined. 86d1ad3

v5.0.1

Compare Source

• Bump xo to 0.38.1 and move to devDependencies. 3f51315

v5.0.0

Compare Source

Breaking changes

• Requires node 12.
• Requires [email protected] (unreleased yo@4).
• Conflicter moved to the Environment.
• Install action is deprecated and is not included by default.
  • Replaced by package.json manipulation
    • addDependencies({dependency: 'version'})
    • addDevDependencies({dependency: 'version'})
    • this.packageJson storage. Eg: this.packageJson.merge({scripts: {test: 'mocha'}});
  • Install task will be executed later by the Environment when package.json changes.
  • To load it:

const Generator = require('yeoman-generator');
-_.extend(Generator.prototype, require('yeoman-generator/lib/actions/install'));

• Singleton Generators support passing unique: 'namespace' or unique: 'argument'.

  constructor(args, options = {}) {
    super(args, {...options, unique: 'namespace'}
  }

• Misc
  • this.(spawnCommand/spawnCommandSync) switched to execa and now defaults cwd to this.destinationRoot().
  • Dropped support for kebab case options.
  • composeWith() isn't chainable anymore and delegates the running to the Environment for singleton checks.
  • Replaced registerTransformStream with queueTransformStream.
    New api executes transformations before the commit operation, and is executed for every generator.
  • Dependencies update.

v4.13.0

Compare Source

• Fix function context at prompt (#​1265) cd1b557
• Update description of prompt (#​1264) 337dddf
• Change from master to main. bc08bee
• Try to start runLoop manually. 384e1bb

v4.12.0

Compare Source

• Fixes running --help.
• Implement registerPriorities.

v4.11.0

Compare Source

• Add Storage caching.
• Add support to generators with no tasks.
• Add Storage proxy, it can be used as a plain js object instead of using get/set.
• Pass the generator as context to ejs (when using built-in shortcuts).
• Bug fixes.

v4.10.1

Compare Source

• Add skipLocalCache option.
  Cache prompt suggestions only to global yo-rc.

v4.10.0

Compare Source

• Add shortcuts to mem-fs-editor methods
• Make properties/functions starting with # reserved for composing.
• Fixes and improvements.

v4.9.0

Compare Source

• Add support to prompts with storage. this.prompt(prompts, this.config); will use the storage to read/write answers.
  • Prompt is ignored if the value is !== undefined (pass --ask-answered to force the prompt to be shown, stored value is the default value)

v4.8.3

Compare Source

• Remove run-queue pause.
  It doesn’t work due to multiple scheduled runs.

v4.8.2

Compare Source

• Improve error handler with newer environments.

v4.8.1

Compare Source

• Revert error handler behavior: Make sure it's not handled.
• Make sure to don't continue runLoop when a error is emitted.

v4.8.0

Compare Source

• Fix security warning.
• Any emitted error rejects #run promise.
• Implement cancellable tasks. (#​1204)
• Add option to forward errors to the environment.
• Make yeoman-environment and mem-fs-editor dependency optional.
• Implement conflicter predefined status (#​1210)
• Allow decoupling generator's and composed generator's cwd from env cwd.
• Implement checkEnvironmentVersion
• Fixes.

v4.7.2

Compare Source

• Add missing parameter to catch.
• Update dependencies.

v4.7.1

Compare Source

• Fixes dependency error.

v4.7.0

Compare Source

• Fix generator standalone run.
• Allow Storage to use lodash paths.

v4.6.0

Compare Source

• Emit event on environment once queued task is done. (#​1172, #​1177)

• Improvements to custom queues (#​1158)

  • Create queueTask, createTaskGroup methods.
  • Add options to custom priorities.

• Implement createStorage convenience method (#​1168)

• Implement localConfigOnly option. (#​1161)

• Add returnNewGenerator option to composeWith (#​1157, #​1170, #​1178)

• Documentation fixes and improvements.

v4.5.0

Compare Source

• Feature: new customPriorities constructor option.
  • For example see test case.
• Feature: new debug method.
  • Uses a debug object with options.namespace as namespace.
• Minor fixes and improvements

v4.4.0

Compare Source

• New dryRun option. Conflicter will skip every file change.
• Storage#commit() now uses fs.writeJSON instead of fs.write(JSON.stringfy())
• Storage allows to omit the name parameter on constructor.

v4.3.0

Compare Source

• New feature: Generator#queueMethod() can now be called with an object.

v4.2.0

Compare Source

• New feature: Support diffing to ignore whitespace change yo node --no-whitespace
• New feature: Generator#composeWith() can now be called with an array of generators.
• Bugfix: Fixes bug when a generator default export is under exports.default (like when compiling es6 modules with Babel)
• • some other minor fixes and improvements

v4.1.0

Compare Source

• New --bail flag who'll exit the generator as soon as a conflict occurs.
• New generator#queueMethod() allows generator to programmatically schedule tasks on the queue. This can be useful for parents generator who're inherited by children generators to schedule some default tasks automatically. (not a very common use, but might be useful in some edge cases)

v4.0.2

Compare Source

• Fix bug with detection of binary files.

v4.0.1

Compare Source

v4.0.0

Compare Source

Breaking

• Officially supports Node >= 8 (dropped support for Node 6)
• Install methods will be run 1 time per set of arguments. Previously we'd only run them once no matter the arguments, this prevented use case like different npm settings for more complicated setup with different targets (server/browser) #​1108

v3.2.0

Compare Source

Added a new optional syntax to use composeWith:

this.composeWith({
    Generator: require('generator-x'),
    path: require.resolve('generator-x')
})

v3.1.1

Compare Source

Fix some issues with --force-install not being detected properly from the command line arguments.

v3.1.0

Compare Source

Add --force-install flag which will cause the generator to throw if the installation phase fail.

v3.0.0

Compare Source

Maintenance release with a few breaking change that shouldn't impact most users.

Breaking

• mem-fs-editor updated to latest release. A sub-dependency moved from node-glob to fast-glob, so some of the this.fs methods glob options will change.
• Install methods: npmInstall, bowerInstall, yarnInstall and installDependencies do not return promises anymore. This behavior was confusing and a major source of bugs. To handle actions after the install might've run (if user didn't specify --skip-install), use the end run loop phase.
• Renamed runInstall to scheduleInstallTask

New

• For users of the Yeoman API: generator.run() now returns a promise as well as taking a callback (the callback will keep working for the foreseeable future as we need to maintains backward compatibility with older generators)

v2.0.5

Compare Source

Output more useful information to end user when a command fails or is skipped.

v2.0.4

Compare Source

• efc52c9 Change options and args order (#​1063)

v2.0.3

Compare Source

• Update dependencies with security vulnerabilities.

v2.0.2

Compare Source

• Fix error when the prompt choices options is provided as a function instead of an array. (Drawback: this will turn off Yeoman reuse of the previously provided answer)

v2.0.1

Compare Source

• Bump dependencies (including security patch on debug)

v2.0.0

Compare Source

This release fix a few bugs and focus on modernizing our codebase to ES6 style.

Breaking changes

• Generator.extend() is replaced in favor of class extends Generator {}
• Generator#github.username() now returns a promise instead of taking a callback
• Install functions now returns promises (installDependencies, runInstall, bowerInstall, npmInstall and yarnInstall)

New features

• installDependencies now accept command line arguments as options for each sub-command (#​1014)

    this.installDependencies({
      npm: {saveDev: true},
      bower: {depth: 0}
    });

Fix

• Fix diffing dying on empty files (#​1028)

v1.1.1

Compare Source

• af3048f Fix issue with API documentation deploy script
• 74cb46f Document legacy Generator.extend method properly - rel #​996
• 6d267f0 Use XO
• 17173a2 chore(package): update yeoman-assert to version 3.0.0 (#​1004)
• 59d0120 Add eslint as direct dev dependency
• cf67f66 Bump dependencies
• ac542ba Bump dev dependencies
• 0b06786 Improve option name validation message
• 67b90f4 Add failing test for Boolean options starting with no-
• 51414c0 Update Travis test matrix

v1.1.0

Compare Source

• Bump mem-fs-editor to v3.0. New this.fs.append() method, and fix bugs with copy and delete operating on non-committed directories.

v1.0.1

Compare Source

• Fix regression where Boolean options couldn't be undefined.

v1.0.0: 🎉

Compare Source

Say allo' to yeoman-generator 1.0 🎉

Most important changes

• Updates to option and argument parsing
• Updates to composeWith
• Simpler default export
• Yarn support
• Deleted deprecated functions

See blog post for detailed information about the changes and hints for migrating your generator.

Full changelog

• 138ed98 v1.0.0
• 871ed39 v1.0.0-rc1
• df7012f Fix composeWith to allow passing explicit arguments for yeoman-generator@<1.0
• 9aa4e02 Alias desc to description in argument/option config
• 1b6eede Remove Gruntfile api - Fix #​744
• fedb2fb Update composeWith to take path or namespace as first argument - Fix #​983
• 1885dec Single way of passing both arguments and options to composed generator
• a852f62 Allow passing arguments to a Generator constructor in the same way as we pass options
• f6f4dda Fix issue #​947 (#​982)
• e1b95d8 Refactor arguments and options parsing
• a3cab64 Disambiguate cli options from spawn options - Fix #​754
• 687b9be Conflicter to handle null file.contents - Fix #​950
• d6345f7 Pass default options to composed generators automatically - Fix #​745
• bddb942 Fix yarnInstall to add new package - Fix #​980
• cd5e34d Simplify root exports
• 3601531 Get rid of yeoman-environment proxying
• 006577a Update tes matrix
• f633dae Remove NamedBase
• 16084c6 Remove jshintrc
• ec9c448 Remove legacy files functions
• 49ce5f3 Remove deprecated modules
• f3fb1d5 Save current config to .yo-rc.json (#​963)
• 4eccb2a Add yarnInstall method
• f632f01 Add version number to generated docs (#​978)
• 7cf5875 Update logo url in api doc
• cf64f57 Switch JSDoc template (#​977)
• 102dd97 Only build and deploy docs on a specific node version (#​976)
• 87b210b Prevent multiple commits of docs in gh-pages branch (#​975)
• 2c34bde npm cache by default (#​940)